From: Samuel Thibault Date: Thu, 4 Dec 2025 16:54:23 +0000 (+0100) Subject: doxygen-choke X-Git-Tag: archive/raspbian/1.4.10+dfsg-2+rpi1^2~1 X-Git-Url: https://dgit.raspbian.org/%22http:/www.example.com/cgi/%22https://%22%22/%22http:/www.example.com/cgi/%22https:/%22%22?a=commitdiff_plain;h=ca294da419ca3b732345a2a262e042f620e065bd;p=starpu.git doxygen-choke commit 1d641863e604a7ced708e63c6a8dbd3e2f6bb781 Author: Samuel Thibault Date: Thu Dec 4 00:18:02 2025 +0100 Fix typos making doxygen 1.15.0 choke Gbp-Pq: Name doxygen-choke --- diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg index 5edefcc..da7fcee 100644 --- a/doc/doxygen.cfg +++ b/doc/doxygen.cfg @@ -644,7 +644,7 @@ QUIET = YES # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. -WARNINGS = NO +WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will diff --git a/doc/doxygen/chapters/api/threads.doxy b/doc/doxygen/chapters/api/threads.doxy index 9d9b2b9..fab2b48 100644 --- a/doc/doxygen/chapters/api/threads.doxy +++ b/doc/doxygen/chapters/api/threads.doxy @@ -219,7 +219,7 @@ This function also produces trace when the configure option Behave identically to starpu_pthread_mutex_lock(), except that it does not block the calling thread if the mutex is already locked by another thread (or by the calling thread in the case -of a ``fast'' mutex). Instead, the function returns immediately with +of a ``fast`` mutex). Instead, the function returns immediately with the error code \c EBUSY. This function also produces trace when the configure option diff --git a/doc/doxygen/chapters/fdl_1_3.doxy b/doc/doxygen/chapters/fdl_1_3.doxy index d66e844..a75c21b 100644 --- a/doc/doxygen/chapters/fdl_1_3.doxy +++ b/doc/doxygen/chapters/fdl_1_3.doxy @@ -40,7 +40,7 @@ Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. -This License is a kind of ``copyleft'', which means that derivative +This License is a kind of ``copyleft``, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. @@ -61,17 +61,17 @@ This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The ``Document'', below, +work under the conditions stated herein. The ``Document``, below, refers to any such manual or work. Any member of the public is a -licensee, and is addressed as ``you''. You accept the license if you +licensee, and is addressed as ``you``. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. -A ``Modified Version'' of the Document means any work containing the +A ``Modified Version`` of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. -A ``Secondary Section'' is a named appendix or a front-matter section +A ``Secondary Section`` is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall @@ -82,7 +82,7 @@ connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. -The ``Invariant Sections'' are certain Secondary Sections whose titles +The ``Invariant Sections`` are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not @@ -90,12 +90,12 @@ allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. -The ``Cover Texts'' are certain short passages of text that are listed, +The ``Cover Texts`` are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. -A ``Transparent'' copy of the Document means a machine-readable copy, +A ``Transparent`` copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of @@ -106,7 +106,7 @@ to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount -of text. A copy that is not ``Transparent'' is called ``Opaque''. +of text. A copy that is not ``Transparent`` is called ``Opaque``. Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input @@ -121,23 +121,23 @@ not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. -The ``Title Page'' means, for a printed book, the title page itself, +The ``Title Page`` means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in -formats which do not have any title page as such, ``Title Page'' means +formats which do not have any title page as such, ``Title Page`` means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text. -The ``publisher'' means any person or entity that distributes copies +The ``publisher`` means any person or entity that distributes copies of the Document to the public. -A section ``Entitled XYZ'' means a named subunit of the Document whose +A section ``Entitled XYZ`` means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as ``Acknowledgements'', -``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' +specific section name mentioned below, such as ``Acknowledgements``, +``Dedications``, ``Endorsements``, or ``History``.) To ``Preserve the Title`` of such a section when you modify the Document means that it remains a -section ``Entitled XYZ'' according to this definition. +section ``Entitled XYZ`` according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty @@ -252,10 +252,10 @@ and required Cover Texts given in the Document's license notice. Include an unaltered copy of this License.
  • -Preserve the section Entitled ``History'', Preserve its Title, and add +Preserve the section Entitled ``History``, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If -there is no section Entitled ``History'' in the Document, create one +there is no section Entitled ``History`` in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. @@ -264,13 +264,13 @@ Version as stated in the previous sentence. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions -it was based on. These may be placed in the ``History'' section. +it was based on. These may be placed in the ``History`` section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
  • -For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve +For any section Entitled ``Acknowledgements`` or ``Dedications``, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. @@ -281,11 +281,11 @@ unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
  • -Delete any section Entitled ``Endorsements''. Such a section +Delete any section Entitled ``Endorsements``. Such a section may not be included in the Modified Version.
  • -Do not retitle any existing section to be Entitled ``Endorsements'' or +Do not retitle any existing section to be Entitled ``Endorsements`` or to conflict in title with any Invariant Section.
  • @@ -300,7 +300,7 @@ of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles. -You may add a section Entitled ``Endorsements'', provided it contains +You may add a section Entitled ``Endorsements``, provided it contains nothing but endorsements of your Modified Version by various parties---for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a @@ -340,11 +340,11 @@ author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. -In the combination, you must combine any sections Entitled ``History'' +In the combination, you must combine any sections Entitled ``History`` in the various original documents, forming one section Entitled -``History''; likewise combine any sections Entitled ``Acknowledgements'', -and any sections Entitled ``Dedications''. You must delete all -sections Entitled ``Endorsements.'' +``History``; likewise combine any sections Entitled ``Acknowledgements``, +and any sections Entitled ``Dedications``. You must delete all +sections Entitled ``Endorsements.``
  • @@ -367,7 +367,7 @@ AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or -distribution medium, is called an ``aggregate'' if the copyright +distribution medium, is called an ``aggregate`` if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not @@ -399,8 +399,8 @@ of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. -If a section in the Document is Entitled ``Acknowledgements'', -``Dedications'', or ``History'', the requirement (section 4) to Preserve +If a section in the Document is Entitled ``Acknowledgements``, +``Dedications``, or ``History``, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
    • @@ -445,7 +445,7 @@ http://www.gnu.org/copyleft/. Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this -License ``or any later version'' applies to it, you have the option of +License ``or any later version`` applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version @@ -460,24 +460,24 @@ Document.
  • RELICENSING -``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any +``Massive Multiauthor Collaboration Site`` (or ``MMC Site``) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A -``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the +``Massive Multiauthor Collaboration`` (or ``MMC``) contained in the site means any set of copyrightable works thus published on the MMC site. -``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 +``CC-BY-SA`` means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization. -``Incorporate'' means to publish or republish a Document, in whole or +``Incorporate`` means to publish or republish a Document, in whole or in part, as part of another Document. -An MMC is ``eligible for relicensing'' if it is licensed under this +An MMC is ``eligible for relicensing`` if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, @@ -502,11 +502,11 @@ license notices just after the title page: or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU - Free Documentation License''. + Free Documentation License``. If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with...Texts.'' line with this: +replace the ``with...Texts.`` line with this:
    with the Invariant Sections being list their titles, with diff --git a/doc/doxygen/chapters/starpu_basics/data_management.doxy b/doc/doxygen/chapters/starpu_basics/data_management.doxy index fdbeb85..44d2d6f 100644 --- a/doc/doxygen/chapters/starpu_basics/data_management.doxy +++ b/doc/doxygen/chapters/starpu_basics/data_management.doxy @@ -290,8 +290,8 @@ uint32_t colind[NNZ_BLOCKS] = }; uint32_t rowptr[NROWS+1] = { - 0, / * block-index in nzval of the first block of the first row. */ - 1, / * block-index in nzval of the first block of the second row. */ + 0, /* block-index in nzval of the first block of the first row. */ + 1, /* block-index in nzval of the first block of the second row. */ NNZ_BLOCKS /* number of blocks, to allow an easier element's access for the kernels */ }; diff --git a/doc/doxygen/chapters/starpu_extensions/advanced_data_management.doxy b/doc/doxygen/chapters/starpu_extensions/advanced_data_management.doxy index 354ef07..5b896aa 100644 --- a/doc/doxygen/chapters/starpu_extensions/advanced_data_management.doxy +++ b/doc/doxygen/chapters/starpu_extensions/advanced_data_management.doxy @@ -360,7 +360,7 @@ can compare examples/interface/complex_interface.c vs StarPU provides a series of predefined filters in \ref API_Data_Partition, but additional filters can be defined by the application. The principle is that the filter function just fills the memory location of the i-th subpart of a data. -Examples are provided in src/datawizard/interfaces/*_filters.c, +Examples are provided in src/datawizard/interfaces/\*_filters.c, check \ref starpu_data_filter::filter_func for further details. The helper function starpu_filter_nparts_compute_chunk_size_and_offset() can be used to compute the division of pieces of data. @@ -723,7 +723,7 @@ In the example described above, the two pointers stored in the data interface are data buffers, which may point into main memory, GPU memory, etc. One may also want to store pointers to meta-data for the interface, for instance the list of dimensions sizes for the n-dimension matrix interface, but such pointers are to -be handled completely differently. More examples are provided in src/datawizard/interfaces/*_interface.c +be handled completely differently. More examples are provided in src/datawizard/interfaces/\*_interface.c More precisely, there are two types of pointers: diff --git a/doc/doxygen/chapters/starpu_extensions/bubble.doxy b/doc/doxygen/chapters/starpu_extensions/bubble.doxy index 54cd67d..62a8c0b 100644 --- a/doc/doxygen/chapters/starpu_extensions/bubble.doxy +++ b/doc/doxygen/chapters/starpu_extensions/bubble.doxy @@ -191,6 +191,6 @@ When executed, the function starpu_codelet::bubble_gen_dag_func will be given as parameter the task being turned into a hierarchical task and the value specified with ::STARPU_BUBBLE_GEN_DAG_FUNC_ARG. -An example involving these functions is in bubble/tests/basic/brec.c. And more examples are available in bubble/tests/basic/*.c. +An example involving these functions is in bubble/tests/basic/brec.c. And more examples are available in bubble/tests/basic/\*.c. */ diff --git a/doc/doxygen/chapters/starpu_extensions/debugging_tools.doxy b/doc/doxygen/chapters/starpu_extensions/debugging_tools.doxy index 06f4d3b..de4558e 100644 --- a/doc/doxygen/chapters/starpu_extensions/debugging_tools.doxy +++ b/doc/doxygen/chapters/starpu_extensions/debugging_tools.doxy @@ -30,7 +30,7 @@ catchup assertions. If your program is valgrind-safe, you can use it, see \ref UsingOtherDebugger. Depending on your toolchain, it might happen that you get -undefined reference to `__stack_chk_guard' errors. In that case, use the +undefined reference to `__stack_chk_guard` errors. In that case, use the --disable-fstack-protector-all option to avoid the issue. Then, if your program crashes with an assertion error, a segfault, etc. you can send us the result of @@ -89,7 +89,7 @@ was passed to configure Valgrind can be used on StarPU: valgrind.h just needs to be found at configure time, to tell valgrind about some known false positives and disable host memory pinning. Other known false positives can be suppressed by giving the suppression -files in tools/valgrind/*.suppr to valgrind's --suppressions option. +files in tools/valgrind/\*.suppr to valgrind's --suppressions option. The environment variable \ref STARPU_DISABLE_KERNELS can also be set to 1 to make StarPU does everything (schedule tasks, transfer memory, etc.) except actually diff --git a/doc/doxygen/chapters/starpu_extensions/max_fpga_support.doxy b/doc/doxygen/chapters/starpu_extensions/max_fpga_support.doxy index b0f4113..c5f1624 100644 --- a/doc/doxygen/chapters/starpu_extensions/max_fpga_support.doxy +++ b/doc/doxygen/chapters/starpu_extensions/max_fpga_support.doxy @@ -274,7 +274,7 @@ The design load can also be delegated to StarPU by specifying an array of load specifications in starpu_conf::max_fpga_load, and use starpu_max_fpga_get_local_engine() to access the loaded max engines. -Complete examples are available in tests/fpga/*.c +Complete examples are available in tests/fpga/\*.c \subsection MaxFPGADataTransfers Data Transfers in StarPU/Maxeler FPGA Applications diff --git a/doc/doxygen/chapters/starpu_extensions/out_of_core.doxy b/doc/doxygen/chapters/starpu_extensions/out_of_core.doxy index c746328..017f44e 100644 --- a/doc/doxygen/chapters/starpu_extensions/out_of_core.doxy +++ b/doc/doxygen/chapters/starpu_extensions/out_of_core.doxy @@ -50,7 +50,7 @@ machine memory size, but part of it is taken by the kernel, the system, daemons, and the application's own allocated data, whose size can not be predicted. That is why users need to specify what StarPU can afford. -Some Out-of-core tests are worth giving a read, see tests/disk/*.c +Some Out-of-core tests are worth giving a read, see tests/disk/\*.c \section UseANewDiskMemory Use a new disk memory diff --git a/doc/doxygen/chapters/starpu_extensions/scheduling_context_hypervisor.doxy b/doc/doxygen/chapters/starpu_extensions/scheduling_context_hypervisor.doxy index 42c715c..30c44ea 100644 --- a/doc/doxygen/chapters/starpu_extensions/scheduling_context_hypervisor.doxy +++ b/doc/doxygen/chapters/starpu_extensions/scheduling_context_hypervisor.doxy @@ -37,7 +37,7 @@ decides accordingly when and how the contexts can be resized. Basic strategies of resizing scheduling contexts already exist, but a platform for implementing additional custom ones is available. -Several examples of hypervisor are provided in sc_hypervisor/examples/*.c +Several examples of hypervisor are provided in sc_hypervisor/examples/\*.c \section StartTheHypervisor Start the Hypervisor @@ -230,6 +230,6 @@ struct sc_hypervisor_policy dummy_policy = }; \endcode -Examples are provided in sc_hypervisor/src/hypervisor_policies/*_policy.c +Examples are provided in sc_hypervisor/src/hypervisor_policies/\*_policy.c */ diff --git a/doc/doxygen/chapters/starpu_extensions/transactions.doxy b/doc/doxygen/chapters/starpu_extensions/transactions.doxy index e9cac8b..3a63681 100644 --- a/doc/doxygen/chapters/starpu_extensions/transactions.doxy +++ b/doc/doxygen/chapters/starpu_extensions/transactions.doxy @@ -60,7 +60,7 @@ will return \c NULL. \subsection TransactionsTasks Transaction Tasks Tasks governed by the same transaction object should be passed that transaction object either through the \c .transaction field of \ref starpu_task structures, using the \ref STARPU_TRANSACTION argument -of \ref starpu_task_insert(). +of starpu_task_insert(). \subsection TransactionsEpochNext Epoch Transition The transition from one transaction epoch to the next is expressed using the diff --git a/doc/doxygen/chapters/starpu_installation/environment_variables.doxy b/doc/doxygen/chapters/starpu_installation/environment_variables.doxy index 556620d..8728d20 100644 --- a/doc/doxygen/chapters/starpu_installation/environment_variables.doxy +++ b/doc/doxygen/chapters/starpu_installation/environment_variables.doxy @@ -1222,13 +1222,6 @@ When unset or set to 0, the platform file created for SimGrid will contain PCI bandwidths and routes. -
    STARPU_SIMGRID_CUDA_QUEUE_COST
    -
    -\anchor STARPU_SIMGRID_CUDA_QUEUE_COST -\addindex __env__STARPU_SIMGRID_CUDA_QUEUE_COST -When unset or set to 1, simulate within SimGrid the GPU transfer queueing. -
    -
    STARPU_MALLOC_SIMULATION_FOLD
    \anchor STARPU_MALLOC_SIMULATION_FOLD diff --git a/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy b/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy index 609025f..39fd564 100644 --- a/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy +++ b/doc/doxygen/chapters/starpu_introduction/introduction_intro.doxy @@ -127,7 +127,7 @@ submitted). \subsection StarPUDataManagementLibrary StarPU Data Management Library As StarPU dynamically schedules tasks at runtime, the need for data -transfers is automatically managed in a``just-in-time'' manner between +transfers is automatically managed in a``just-in-time`` manner between different processing units, This automated approach alleviates the burden on application programmers to explicitly handle data transfers. diff --git a/include/starpu_openmp.h b/include/starpu_openmp.h index 71c5edb..0649b74 100644 --- a/include/starpu_openmp.h +++ b/include/starpu_openmp.h @@ -56,7 +56,7 @@ typedef struct /** Set of constants for selecting the for loop iteration scheduling - algorithm (\anchor OMPFor) as defined by the OpenMP specification. + algorithm (see \ref OMPFor) as defined by the OpenMP specification. \sa starpu_omp_for() \sa starpu_omp_for_inline_first() \sa starpu_omp_for_inline_next() diff --git a/include/starpu_perf_steering.h b/include/starpu_perf_steering.h index 0a3215e..b9d9674 100644 --- a/include/starpu_perf_steering.h +++ b/include/starpu_perf_steering.h @@ -31,7 +31,7 @@ extern "C" { /** @name API - \anchor PM_API + \anchor PS_API @{ */ diff --git a/include/starpu_sched_component.h b/include/starpu_sched_component.h index e3573b4..2130d8e 100644 --- a/include/starpu_sched_component.h +++ b/include/starpu_sched_component.h @@ -742,6 +742,8 @@ struct starpu_sched_component_specs struct starpu_sched_tree *starpu_sched_component_make_scheduler(unsigned sched_ctx_id, struct starpu_sched_component_specs s); #endif /* STARPU_HAVE_HWLOC */ +/** @} */ + /** @name Basic API @{ diff --git a/mpi/include/starpu_mpi.h b/mpi/include/starpu_mpi.h index 386135b..8d0f34c 100644 --- a/mpi/include/starpu_mpi.h +++ b/mpi/include/starpu_mpi.h @@ -1018,6 +1018,8 @@ void starpu_mpi_tags_free(int64_t mintag); /** @} */ +/** @} */ + #ifdef __cplusplus } #endif diff --git a/mpi/include/starpu_mpi_ft.h b/mpi/include/starpu_mpi_ft.h index 4d8e43a..268b286 100644 --- a/mpi/include/starpu_mpi_ft.h +++ b/mpi/include/starpu_mpi_ft.h @@ -123,10 +123,10 @@ static inline int starpu_mpi_checkpoint_template_print(starpu_mpi_checkpoint_tem static inline int starpu_mpi_checkpoint_init(void) { return 0; } static inline int starpu_mpi_checkpoint_shutdown(void) { return 0; } -/** @} */ - #endif // STARPU_USE_MPI_FT +/** @} */ + #ifdef __cplusplus } #endif